Fix permanent drift in databricks_model_serving when using plaintext credentials
#5125
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #5074 The GET API for serving endpoints does not return sensitive *_plaintext credential fields for external models (e.g., openai_api_key_plaintext, google_service_account_key_plaintext). This causes Terraform to detect drift even when no actual changes have been made. Changes: - Added reflection-based copySensitiveFields() helper function that automatically copies all *Plaintext fields from Terraform state to API response during Read operations - Applied fix to both databricks_model_serving and databricks_model_serving_provisioned_throughput resources - Added comprehensive unit tests for the sensitive field copying logic - Refactored sensitive field tests to use MockWorkspaceClientFunc pattern The solution is generic and will automatically handle new external model providers and their plaintext credential fields without code changes.
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
rauchy
reviewed
Nov 11, 2025
Contributor
rauchy
left a comment
rauchy
left a comment
There was a problem hiding this comment.
Looks good, but wouldn't an explicit and concrete solution using SetSensitive simplify here?
--- a/serving/resource_model_serving_provisioned_throughput.go
+++ b/serving/resource_model_serving_provisioned_throughput.go
@@ -30,6 +30,19 @@ func ResourceModelServingProvisionedThroughput() common.Resource {
common.CustomizeSchemaPath(m, "ai_gateway", "guardrails", "input", "pii").SetOptional().SetComputed()
common.CustomizeSchemaPath(m, "ai_gateway", "guardrails", "input", "pii", "behavior").SetOptional().SetComputed()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "ai21labs_config", "ai21labs_api_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "amazon_bedrock_config", "aws_access_key_id_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "amazon_bedrock_config", "aws_secret_access_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "anthropic_config", "anthropic_api_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "cohere_config", "cohere_api_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "databricks_model_serving_config", "databricks_api_token_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "google_cloud_vertex_ai_config", "private_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "openai_config", "openai_api_key_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "openai_config", "microsoft_entra_client_secret_plaintext").SetSensitive()
+ common.CustomizeSchemaPath(m, "config", "served_entities", "external_model", "palm_config", "palm_api_key_plaintext").SetSensitive()
+
Contributor
Author
|
@rauchy SetSensitive alone won't help - the value isn't returned by the backend, leading to setting it to empty string on Read |
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
alexott
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
The GET API for serving endpoints does not return sensitive *_plaintext credential fields for external models (e.g., openai_api_key_plaintext, google_service_account_key_plaintext). This causes Terraform to detect drift even when no actual changes have been made.
Changes:
The solution is generic and will automatically handle new external model providers and their plaintext credential fields without code changes.
Fixes #5074
Tests
make testrun locallydocs/folderinternal/acceptanceNEXT_CHANGELOG.mdfile